/**
 * This file is part of 1genia trampoline
 * Copyright (C) 2007 1genia (contact@1genia.com)
 *
 * This library is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; version 3 of the License. 
 *
 * This library is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Library General Public License for more details. 
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; see the file COPYING.TXT.  If not,
 * write to the Free Software Foundation, Inc., 51 Franklin Street,
 * Fifth Floor, Boston, MA 02110-1301, USA. 
 **/
package com.genia.toolbox.persistence.memory.criteria.field;

import java.util.ArrayList;
import java.util.List;

import com.genia.toolbox.persistence.basis.criteria.BasicCriteriaResult;
import com.genia.toolbox.persistence.criteria.field.Field;
import com.genia.toolbox.persistence.exception.AggregateException;
import com.genia.toolbox.persistence.exception.FieldDefinitionException;

/**
 * the base of the implementation of <code>Field</code> for the memory
 * implementation of the persistence API.
 */
public abstract class AbstractMemoryField
    implements Field
{

  /**
   * Return the value of this field for the given lines of result.
   * 
   * @param lines
   *          the lines of result we compute the field on
   * @return the value of this field for the given line of result
   * @throws FieldDefinitionException
   *           when there is an error in the definition of the field
   * @throws AggregateException
   *           when there is an error with an aggregate definition
   */
  public abstract Object getValue(List<BasicCriteriaResult<?>> lines)
      throws FieldDefinitionException, AggregateException;



  /**
   * Return the value of this field for the given line of result.
   * 
   * @param line
   *          the lines of result we compute the field on
   * @return the value of this field for the given line of result
   * @throws FieldDefinitionException
   *           when there is an error in the definition of the field
   * @throws AggregateException
   *           when there is an error with an aggregate definition
   */
  public Object getSimpleValue(final BasicCriteriaResult<?> line)
      throws FieldDefinitionException, AggregateException
  {
    if (isAggregate()) {
      throw new AggregateException();
    }
    final List<BasicCriteriaResult<?>> lines = new ArrayList<BasicCriteriaResult<?>>();
    lines.add(line);
    return getValue(lines);
  }
}
